<!-- HTML header for doxygen 1.9.7-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<title>libsir: The Standard Incident Reporter Library</title>
<!-- OpenGraph -->
<meta property="og:title" content="libsir: The Standard Incident Reporter Library">
<meta property="og:description" content="A lightweight, cross-platform C library for information distribution">
<meta property="og:url" content="https://libsir.rml.dev">
<meta property="og:type" content="website">
<meta property="og:image" content="https://libsir.rml.dev/res/libsir-og.png">
<meta name="twitter:card" content="summary_large_image"></meta>
<meta name="twitter:title" content="libsir: The Standard Incident Reporter Library"></meta>
<meta name="twitter:description" content="A lightweight, cross-platform C library for information distribution"></meta>
<meta name="twitter:image" content="https://libsir.rml.dev/res/libsir-og.png"></meta>
<!-- /OpenGraph -->
<!-- favicon -->
<link rel="icon" href="res/libsir-icon.png">
<link rel="icon" href="res/libsir-icon.svg" type="image/svg+xml">
<link rel="manifest" href="res/icons.webmanifest">
<!-- /favicon -->
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
<link href="rml-navtree.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">libsir<span id="projectnumber">&#160;2.2.6</span>
   </div>
   <div id="projectbrief">Standard Incident Reporter</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('sir_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">sir.h</div></div>
</div><!--header-->
<div class="contents">
<a href="sir_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#ifndef _SIR_H_INCLUDED</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="preprocessor"># define _SIR_H_INCLUDED</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor"># include &quot;sir/platform.h&quot;</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor"># include &quot;sir/version.h&quot;</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor"># include &quot;sir/types.h&quot;</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="preprocessor"># if defined(SWIG)</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="preprocessor">#  define PRINTF_FORMAT</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="preprocessor">#  define PRINTF_FORMAT_ATTR(fmt_p, va_p)</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor"># endif</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="preprocessor"># if defined(__cplusplus)</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="preprocessor"># endif</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gac21fb86ac7e7710400bf8b642887ad96">sir_makeinit</a>(<a class="code hl_struct" href="group__publictypes.html#structsirinit">sirinit</a>* si);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gaa4f5707f5e4ed9702cde75a8c80c4e4a">sir_init</a>(<a class="code hl_struct" href="group__publictypes.html#structsirinit">sirinit</a>* si);</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga9bf3e92cefac01de4e3c6c359a58706f">sir_cleanup</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gac4cfb0e00a47760eb1778d78dd84b290">sir_isinitialized</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>uint16_t <a class="code hl_function" href="group__publicfuncs.html#gac0c399c73c25d1128befc6b75cbae300">sir_geterror</a>(<span class="keywordtype">char</span> message[<a class="code hl_define" href="config_8h.html#ad6fce840144259e992c33fb611f31262">SIR_MAXERROR</a>]);</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__publicfuncs.html#gaedefdc4fb0546a210740ad0fb87f7b34">sir_geterrorinfo</a>(<a class="code hl_struct" href="group__publictypes.html#structsir__errorinfo">sir_errorinfo</a>* err);</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span>PRINTF_FORMAT_ATTR(1, 2)</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span>bool <a class="code hl_function" href="group__publicfuncs.html#ga7e2563198d16d5c7ba7bdf55fec9215c">sir_debug</a>(PRINTF_FORMAT const <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span>PRINTF_FORMAT_ATTR(1, 2)</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga9aa2c092ae4ff0bf75043dce10166661">sir_info</a>(PRINTF_FORMAT const <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span>PRINTF_FORMAT_ATTR(1, 2)</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga3b8cad62f929e549f2d031470e3a1fc7">sir_notice</a>(PRINTF_FORMAT const <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span>PRINTF_FORMAT_ATTR(1, 2)</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gabf71ddaf533f10cf278986d4bdb3f76f">sir_warn</a>(PRINTF_FORMAT const <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span>PRINTF_FORMAT_ATTR(1, 2)</div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga3955274b94bf3d09ad8ebefd93035aa3">sir_error</a>(PRINTF_FORMAT const <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span>PRINTF_FORMAT_ATTR(1, 2)</div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gab4836aea12ba1a2b187f325a416ea9c2">sir_crit</a>(PRINTF_FORMAT const <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span>PRINTF_FORMAT_ATTR(1, 2)</div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga235d760d94e67fcf82ccc16c77a8249e">sir_alert</a>(PRINTF_FORMAT const <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span>PRINTF_FORMAT_ATTR(1, 2)</div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gaf94f3dcbd6a14e81f6eca555733dce23">sir_emerg</a>(PRINTF_FORMAT const <span class="keywordtype">char</span>* format, ...);</div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><a class="code hl_typedef" href="group__publictypes.html#ga0da4ab4b4468b6b71cd8e924b2adf2e2">sirfileid</a> <a class="code hl_function" href="group__publicfuncs.html#gaa04f4ca1fc06e1d99ca4f0fd6422b573">sir_addfile</a>(const <span class="keywordtype">char</span>* path, <a class="code hl_typedef" href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a> levels, <a class="code hl_typedef" href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a> opts);</div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gaba84f2fef8ac18a28483ee02c1c57240">sir_remfile</a>(<a class="code hl_typedef" href="group__publictypes.html#ga0da4ab4b4468b6b71cd8e924b2adf2e2">sirfileid</a> <span class="keywordtype">id</span>);</div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span><a class="code hl_typedef" href="group__publictypes.html#gadbc71df98df765cddfed4aa11c805470">sirpluginid</a> <a class="code hl_function" href="group__publicfuncs.html#ga1a50b52b3ce1af7543b76a219ff01060">sir_loadplugin</a>(const <span class="keywordtype">char</span>* path);</div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span></div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga6796c068e61eb505e8dd8e230fbc1423">sir_unloadplugin</a>(<a class="code hl_typedef" href="group__publictypes.html#gadbc71df98df765cddfed4aa11c805470">sirpluginid</a> <span class="keywordtype">id</span>);</div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span></div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga5a776d3d55e9f993eb0fad82788e1160">sir_filelevels</a>(<a class="code hl_typedef" href="group__publictypes.html#ga0da4ab4b4468b6b71cd8e924b2adf2e2">sirfileid</a> <span class="keywordtype">id</span>, <a class="code hl_typedef" href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a> levels);</div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gaf14164a64eca824a2bae72ef4e9689cd">sir_fileopts</a>(<a class="code hl_typedef" href="group__publictypes.html#ga0da4ab4b4468b6b71cd8e924b2adf2e2">sirfileid</a> <span class="keywordtype">id</span>, <a class="code hl_typedef" href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a> opts);</div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga1a4726075fbcea9fc311f059e342213f">sir_settextstyle</a>(<a class="code hl_typedef" href="group__publictypes.html#ga076e759e9aa36cde2977f754a7ea186c">sir_level</a> level, <a class="code hl_enumeration" href="group__publictypes.html#ga1bf5e489a6af0dcb905788c1e7a5ec2d">sir_textattr</a> attr, <a class="code hl_typedef" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> fg,</div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span>    <a class="code hl_typedef" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> bg);</div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span></div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga932eec2f9c73eecdd2b6b935452e5eed">sir_resettextstyles</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno">  559</span></div>
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno">  575</span><a class="code hl_typedef" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> <a class="code hl_function" href="group__publicfuncs.html#ga4691e42964819230e1f4b7fdf984ff66">sir_makergb</a>(<a class="code hl_typedef" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> r, <a class="code hl_typedef" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> g, <a class="code hl_typedef" href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a> b);</div>
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno">  576</span></div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno">  604</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga31639aba9a825f957a73689ef509f33d">sir_setcolormode</a>(<a class="code hl_enumeration" href="group__publictypes.html#ga26686b620930358e8b50f287d6c96e51">sir_colormode</a> mode);</div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno">  605</span></div>
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno">  626</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga6f17febe99cb0beb6f8119283cc62d42">sir_stdoutlevels</a>(<a class="code hl_typedef" href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a> levels);</div>
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno">  627</span></div>
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno">  648</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gac117aaf4a045115e58ba4471f9a4747f">sir_stdoutopts</a>(<a class="code hl_typedef" href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a> opts);</div>
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno">  649</span></div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno">  670</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga421c13f6e269440cef0ac5c1ff3e65dd">sir_stderrlevels</a>(<a class="code hl_typedef" href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a> levels);</div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno">  671</span></div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno">  692</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga0e78fb3ad87f02ef0f056a34200a4ab9">sir_stderropts</a>(<a class="code hl_typedef" href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a> opts);</div>
<div class="line"><a id="l00693" name="l00693"></a><span class="lineno">  693</span></div>
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno">  715</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga2b383287c821bb519868776a4d8bae83">sir_sysloglevels</a>(<a class="code hl_typedef" href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a> levels);</div>
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno">  716</span></div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno">  734</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#ga5b32a04501257df43bbe56169ab383c2">sir_syslogopts</a>(<a class="code hl_typedef" href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a> opts);</div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno">  735</span></div>
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno">  760</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gabc5831ef9b59c181b6ad7944c2ef1d5f">sir_syslogid</a>(const <span class="keywordtype">char</span>* identity);</div>
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno">  761</span></div>
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno">  788</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gac48e99ced63f02c6999f50aca7c56efd">sir_syslogcat</a>(const <span class="keywordtype">char</span>* category);</div>
<div class="line"><a id="l00789" name="l00789"></a><span class="lineno">  789</span></div>
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno">  805</span>const <span class="keywordtype">char</span>* <a class="code hl_function" href="group__publicfuncs.html#gad1e38749df3016bd75c3d7442b708ee9">sir_getversionstring</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno">  806</span></div>
<div class="line"><a id="l00814" name="l00814"></a><span class="lineno">  814</span>uint32_t <a class="code hl_function" href="group__publicfuncs.html#ga747855ef6deb460266e79629d19451ab">sir_getversionhex</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00815" name="l00815"></a><span class="lineno">  815</span></div>
<div class="line"><a id="l00822" name="l00822"></a><span class="lineno">  822</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__publicfuncs.html#gaf7c8bdb30b25e51a494271851677a8d3">sir_isprerelease</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00823" name="l00823"></a><span class="lineno">  823</span></div>
<div class="line"><a id="l00828" name="l00828"></a><span class="lineno">  828</span> </div>
<div class="line"><a id="l00829" name="l00829"></a><span class="lineno">  829</span><span class="preprocessor"># if defined(__cplusplus)</span></div>
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno">  830</span>}</div>
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno">  831</span><span class="preprocessor"># endif</span></div>
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno">  832</span> </div>
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno">  833</span><span class="preprocessor">#endif </span><span class="comment">/* !_SIR_H_INCLUDED */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aconfig_8h_html_ad6fce840144259e992c33fb611f31262"><div class="ttname"><a href="config_8h.html#ad6fce840144259e992c33fb611f31262">SIR_MAXERROR</a></div><div class="ttdeci">#define SIR_MAXERROR</div><div class="ttdoc">The maximum size, in characters, of an error message.</div><div class="ttdef"><b>Definition</b> config.h:419</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga0e78fb3ad87f02ef0f056a34200a4ab9"><div class="ttname"><a href="group__publicfuncs.html#ga0e78fb3ad87f02ef0f056a34200a4ab9">sir_stderropts</a></div><div class="ttdeci">bool sir_stderropts(sir_options opts)</div><div class="ttdoc">Set new formatting options for stderr.</div><div class="ttdef"><b>Definition</b> sir.c:211</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga1a4726075fbcea9fc311f059e342213f"><div class="ttname"><a href="group__publicfuncs.html#ga1a4726075fbcea9fc311f059e342213f">sir_settextstyle</a></div><div class="ttdeci">bool sir_settextstyle(sir_level level, sir_textattr attr, sir_textcolor fg, sir_textcolor bg)</div><div class="ttdoc">Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.</div><div class="ttdef"><b>Definition</b> sir.c:170</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga1a50b52b3ce1af7543b76a219ff01060"><div class="ttname"><a href="group__publicfuncs.html#ga1a50b52b3ce1af7543b76a219ff01060">sir_loadplugin</a></div><div class="ttdeci">sirpluginid sir_loadplugin(const char *path)</div><div class="ttdoc">Loads a plugin module from disk.</div><div class="ttdef"><b>Definition</b> sir.c:140</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga235d760d94e67fcf82ccc16c77a8249e"><div class="ttname"><a href="group__publicfuncs.html#ga235d760d94e67fcf82ccc16c77a8249e">sir_alert</a></div><div class="ttdeci">bool sir_alert(PRINTF_FORMAT const char *format,...)</div><div class="ttdoc">Dispatches a SIRL_ALERT level message.</div><div class="ttdef"><b>Definition</b> sir.c:117</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga2b383287c821bb519868776a4d8bae83"><div class="ttname"><a href="group__publicfuncs.html#ga2b383287c821bb519868776a4d8bae83">sir_sysloglevels</a></div><div class="ttdeci">bool sir_sysloglevels(sir_levels levels)</div><div class="ttdoc">Set new level registrations for the system logger destination.</div><div class="ttdef"><b>Definition</b> sir.c:217</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga31639aba9a825f957a73689ef509f33d"><div class="ttname"><a href="group__publicfuncs.html#ga31639aba9a825f957a73689ef509f33d">sir_setcolormode</a></div><div class="ttdeci">bool sir_setcolormode(sir_colormode mode)</div><div class="ttdoc">Sets the ANSI color mode for stdio destinations.</div><div class="ttdef"><b>Definition</b> sir.c:189</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga3955274b94bf3d09ad8ebefd93035aa3"><div class="ttname"><a href="group__publicfuncs.html#ga3955274b94bf3d09ad8ebefd93035aa3">sir_error</a></div><div class="ttdeci">bool sir_error(PRINTF_FORMAT const char *format,...)</div><div class="ttdoc">Dispatches a SIRL_ERROR level message.</div><div class="ttdef"><b>Definition</b> sir.c:101</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga3b8cad62f929e549f2d031470e3a1fc7"><div class="ttname"><a href="group__publicfuncs.html#ga3b8cad62f929e549f2d031470e3a1fc7">sir_notice</a></div><div class="ttdeci">bool sir_notice(PRINTF_FORMAT const char *format,...)</div><div class="ttdoc">Dispatches a SIRL_NOTICE level message.</div><div class="ttdef"><b>Definition</b> sir.c:85</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga421c13f6e269440cef0ac5c1ff3e65dd"><div class="ttname"><a href="group__publicfuncs.html#ga421c13f6e269440cef0ac5c1ff3e65dd">sir_stderrlevels</a></div><div class="ttdeci">bool sir_stderrlevels(sir_levels levels)</div><div class="ttdoc">Set new level registrations for stderr.</div><div class="ttdef"><b>Definition</b> sir.c:205</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga4691e42964819230e1f4b7fdf984ff66"><div class="ttname"><a href="group__publicfuncs.html#ga4691e42964819230e1f4b7fdf984ff66">sir_makergb</a></div><div class="ttdeci">sir_textcolor sir_makergb(sir_textcolor r, sir_textcolor g, sir_textcolor b)</div><div class="ttdoc">Creates a sir_textcolor from red, green, and blue components.</div><div class="ttdef"><b>Definition</b> sir.c:185</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga5a776d3d55e9f993eb0fad82788e1160"><div class="ttname"><a href="group__publicfuncs.html#ga5a776d3d55e9f993eb0fad82788e1160">sir_filelevels</a></div><div class="ttdeci">bool sir_filelevels(sirfileid id, sir_levels levels)</div><div class="ttdoc">Set new level registrations for a log file already managed by libsir.</div><div class="ttdef"><b>Definition</b> sir.c:158</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga5b32a04501257df43bbe56169ab383c2"><div class="ttname"><a href="group__publicfuncs.html#ga5b32a04501257df43bbe56169ab383c2">sir_syslogopts</a></div><div class="ttdeci">bool sir_syslogopts(sir_options opts)</div><div class="ttdoc">Set new formatting options for the system logger destination.</div><div class="ttdef"><b>Definition</b> sir.c:228</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga6796c068e61eb505e8dd8e230fbc1423"><div class="ttname"><a href="group__publicfuncs.html#ga6796c068e61eb505e8dd8e230fbc1423">sir_unloadplugin</a></div><div class="ttdeci">bool sir_unloadplugin(sirpluginid id)</div><div class="ttdoc">Unloads a previously registered plugin module.</div><div class="ttdef"><b>Definition</b> sir.c:149</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga6f17febe99cb0beb6f8119283cc62d42"><div class="ttname"><a href="group__publicfuncs.html#ga6f17febe99cb0beb6f8119283cc62d42">sir_stdoutlevels</a></div><div class="ttdeci">bool sir_stdoutlevels(sir_levels levels)</div><div class="ttdoc">Set new level registrations for stdout.</div><div class="ttdef"><b>Definition</b> sir.c:193</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga747855ef6deb460266e79629d19451ab"><div class="ttname"><a href="group__publicfuncs.html#ga747855ef6deb460266e79629d19451ab">sir_getversionhex</a></div><div class="ttdeci">uint32_t sir_getversionhex(void)</div><div class="ttdoc">Returns the current libsir version as a number.</div><div class="ttdef"><b>Definition</b> sir.c:263</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga7e2563198d16d5c7ba7bdf55fec9215c"><div class="ttname"><a href="group__publicfuncs.html#ga7e2563198d16d5c7ba7bdf55fec9215c">sir_debug</a></div><div class="ttdeci">bool sir_debug(PRINTF_FORMAT const char *format,...)</div><div class="ttdoc">Dispatches a SIRL_DEBUG level message.</div><div class="ttdef"><b>Definition</b> sir.c:69</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga932eec2f9c73eecdd2b6b935452e5eed"><div class="ttname"><a href="group__publicfuncs.html#ga932eec2f9c73eecdd2b6b935452e5eed">sir_resettextstyles</a></div><div class="ttdeci">bool sir_resettextstyles(void)</div><div class="ttdoc">Reset text styling for stdio (stdout/stderr) destinations to their default values.</div><div class="ttdef"><b>Definition</b> sir.c:181</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga9aa2c092ae4ff0bf75043dce10166661"><div class="ttname"><a href="group__publicfuncs.html#ga9aa2c092ae4ff0bf75043dce10166661">sir_info</a></div><div class="ttdeci">bool sir_info(PRINTF_FORMAT const char *format,...)</div><div class="ttdoc">Dispatches a SIRL_INFO level message.</div><div class="ttdef"><b>Definition</b> sir.c:77</div></div>
<div class="ttc" id="agroup__publicfuncs_html_ga9bf3e92cefac01de4e3c6c359a58706f"><div class="ttname"><a href="group__publicfuncs.html#ga9bf3e92cefac01de4e3c6c359a58706f">sir_cleanup</a></div><div class="ttdeci">bool sir_cleanup(void)</div><div class="ttdoc">Tears down and cleans up libsir after use.</div><div class="ttdef"><b>Definition</b> sir.c:52</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gaa04f4ca1fc06e1d99ca4f0fd6422b573"><div class="ttname"><a href="group__publicfuncs.html#gaa04f4ca1fc06e1d99ca4f0fd6422b573">sir_addfile</a></div><div class="ttdeci">sirfileid sir_addfile(const char *path, sir_levels levels, sir_options opts)</div><div class="ttdoc">Adds a log file and registers it to receive log output.</div><div class="ttdef"><b>Definition</b> sir.c:132</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gaa4f5707f5e4ed9702cde75a8c80c4e4a"><div class="ttname"><a href="group__publicfuncs.html#gaa4f5707f5e4ed9702cde75a8c80c4e4a">sir_init</a></div><div class="ttdeci">bool sir_init(sirinit *si)</div><div class="ttdoc">Initializes libsir for use.</div><div class="ttdef"><b>Definition</b> sir.c:48</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gab4836aea12ba1a2b187f325a416ea9c2"><div class="ttname"><a href="group__publicfuncs.html#gab4836aea12ba1a2b187f325a416ea9c2">sir_crit</a></div><div class="ttdeci">bool sir_crit(PRINTF_FORMAT const char *format,...)</div><div class="ttdoc">Dispatches a SIRL_CRIT level message.</div><div class="ttdef"><b>Definition</b> sir.c:109</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gaba84f2fef8ac18a28483ee02c1c57240"><div class="ttname"><a href="group__publicfuncs.html#gaba84f2fef8ac18a28483ee02c1c57240">sir_remfile</a></div><div class="ttdeci">bool sir_remfile(sirfileid id)</div><div class="ttdoc">Removes a file previously added to libsir.</div><div class="ttdef"><b>Definition</b> sir.c:136</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gabc5831ef9b59c181b6ad7944c2ef1d5f"><div class="ttname"><a href="group__publicfuncs.html#gabc5831ef9b59c181b6ad7944c2ef1d5f">sir_syslogid</a></div><div class="ttdeci">bool sir_syslogid(const char *identity)</div><div class="ttdoc">Set new system logger identity.</div><div class="ttdef"><b>Definition</b> sir.c:239</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gabf71ddaf533f10cf278986d4bdb3f76f"><div class="ttname"><a href="group__publicfuncs.html#gabf71ddaf533f10cf278986d4bdb3f76f">sir_warn</a></div><div class="ttdeci">bool sir_warn(PRINTF_FORMAT const char *format,...)</div><div class="ttdoc">Dispatches a SIRL_WARN level message.</div><div class="ttdef"><b>Definition</b> sir.c:93</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gac0c399c73c25d1128befc6b75cbae300"><div class="ttname"><a href="group__publicfuncs.html#gac0c399c73c25d1128befc6b75cbae300">sir_geterror</a></div><div class="ttdeci">uint16_t sir_geterror(char message[SIR_MAXERROR])</div><div class="ttdoc">Retrieves a formatted message for the last error that occurred on the calling thread and returns the ...</div><div class="ttdef"><b>Definition</b> sir.c:60</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gac117aaf4a045115e58ba4471f9a4747f"><div class="ttname"><a href="group__publicfuncs.html#gac117aaf4a045115e58ba4471f9a4747f">sir_stdoutopts</a></div><div class="ttdeci">bool sir_stdoutopts(sir_options opts)</div><div class="ttdoc">Set new formatting options for stdout.</div><div class="ttdef"><b>Definition</b> sir.c:199</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gac21fb86ac7e7710400bf8b642887ad96"><div class="ttname"><a href="group__publicfuncs.html#gac21fb86ac7e7710400bf8b642887ad96">sir_makeinit</a></div><div class="ttdeci">bool sir_makeinit(sirinit *si)</div><div class="ttdoc">Fills out a sirinit structure with default values.</div><div class="ttdef"><b>Definition</b> sir.c:44</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gac48e99ced63f02c6999f50aca7c56efd"><div class="ttname"><a href="group__publicfuncs.html#gac48e99ced63f02c6999f50aca7c56efd">sir_syslogcat</a></div><div class="ttdeci">bool sir_syslogcat(const char *category)</div><div class="ttdoc">Set new system logger category.</div><div class="ttdef"><b>Definition</b> sir.c:249</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gac4cfb0e00a47760eb1778d78dd84b290"><div class="ttname"><a href="group__publicfuncs.html#gac4cfb0e00a47760eb1778d78dd84b290">sir_isinitialized</a></div><div class="ttdeci">bool sir_isinitialized(void)</div><div class="ttdoc">Determines whether or not libsir is in the initialized state.</div><div class="ttdef"><b>Definition</b> sir.c:56</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gad1e38749df3016bd75c3d7442b708ee9"><div class="ttname"><a href="group__publicfuncs.html#gad1e38749df3016bd75c3d7442b708ee9">sir_getversionstring</a></div><div class="ttdeci">const char * sir_getversionstring(void)</div><div class="ttdoc">Returns the current libsir version as a string.</div><div class="ttdef"><b>Definition</b> sir.c:259</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gaedefdc4fb0546a210740ad0fb87f7b34"><div class="ttname"><a href="group__publicfuncs.html#gaedefdc4fb0546a210740ad0fb87f7b34">sir_geterrorinfo</a></div><div class="ttdeci">void sir_geterrorinfo(sir_errorinfo *err)</div><div class="ttdoc">Retrieves granular information about the last error that occurred on the calling thread.</div><div class="ttdef"><b>Definition</b> sir.c:64</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gaf14164a64eca824a2bae72ef4e9689cd"><div class="ttname"><a href="group__publicfuncs.html#gaf14164a64eca824a2bae72ef4e9689cd">sir_fileopts</a></div><div class="ttdeci">bool sir_fileopts(sirfileid id, sir_options opts)</div><div class="ttdoc">Set new formatting options for a log file already managed by libsir.</div><div class="ttdef"><b>Definition</b> sir.c:164</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gaf7c8bdb30b25e51a494271851677a8d3"><div class="ttname"><a href="group__publicfuncs.html#gaf7c8bdb30b25e51a494271851677a8d3">sir_isprerelease</a></div><div class="ttdeci">bool sir_isprerelease(void)</div><div class="ttdoc">Whether or not this is a pre-release version of libsir.</div><div class="ttdef"><b>Definition</b> sir.c:267</div></div>
<div class="ttc" id="agroup__publicfuncs_html_gaf94f3dcbd6a14e81f6eca555733dce23"><div class="ttname"><a href="group__publicfuncs.html#gaf94f3dcbd6a14e81f6eca555733dce23">sir_emerg</a></div><div class="ttdeci">bool sir_emerg(PRINTF_FORMAT const char *format,...)</div><div class="ttdoc">Dispatches a SIRL_EMERG level message.</div><div class="ttdef"><b>Definition</b> sir.c:125</div></div>
<div class="ttc" id="agroup__publictypes_html_ga076e759e9aa36cde2977f754a7ea186c"><div class="ttname"><a href="group__publictypes.html#ga076e759e9aa36cde2977f754a7ea186c">sir_level</a></div><div class="ttdeci">uint16_t sir_level</div><div class="ttdoc">The sir_level type.</div><div class="ttdef"><b>Definition</b> types.h:71</div></div>
<div class="ttc" id="agroup__publictypes_html_ga0da4ab4b4468b6b71cd8e924b2adf2e2"><div class="ttname"><a href="group__publictypes.html#ga0da4ab4b4468b6b71cd8e924b2adf2e2">sirfileid</a></div><div class="ttdeci">uint32_t sirfileid</div><div class="ttdoc">Log file identifier type.</div><div class="ttdef"><b>Definition</b> types.h:49</div></div>
<div class="ttc" id="agroup__publictypes_html_ga1bf5e489a6af0dcb905788c1e7a5ec2d"><div class="ttname"><a href="group__publictypes.html#ga1bf5e489a6af0dcb905788c1e7a5ec2d">sir_textattr</a></div><div class="ttdeci">sir_textattr</div><div class="ttdoc">Attributes for stdio output.</div><div class="ttdef"><b>Definition</b> types.h:107</div></div>
<div class="ttc" id="agroup__publictypes_html_ga26686b620930358e8b50f287d6c96e51"><div class="ttname"><a href="group__publictypes.html#ga26686b620930358e8b50f287d6c96e51">sir_colormode</a></div><div class="ttdeci">sir_colormode</div><div class="ttdoc">Color mode selection.</div><div class="ttdef"><b>Definition</b> types.h:99</div></div>
<div class="ttc" id="agroup__publictypes_html_ga7ee5f2908abd2df9e89bcab0b6608edd"><div class="ttname"><a href="group__publictypes.html#ga7ee5f2908abd2df9e89bcab0b6608edd">sir_levels</a></div><div class="ttdeci">uint16_t sir_levels</div><div class="ttdoc">sir_level bitmask type.</div><div class="ttdef"><b>Definition</b> types.h:74</div></div>
<div class="ttc" id="agroup__publictypes_html_gab4214e294af5ac3c91f21c1d379e10c5"><div class="ttname"><a href="group__publictypes.html#gab4214e294af5ac3c91f21c1d379e10c5">sir_textcolor</a></div><div class="ttdeci">uint32_t sir_textcolor</div><div class="ttdoc">stdio text color type.</div><div class="ttdef"><b>Definition</b> types.h:141</div></div>
<div class="ttc" id="agroup__publictypes_html_gadbc71df98df765cddfed4aa11c805470"><div class="ttname"><a href="group__publictypes.html#gadbc71df98df765cddfed4aa11c805470">sirpluginid</a></div><div class="ttdeci">uint32_t sirpluginid</div><div class="ttdoc">Plugin module identifier type.</div><div class="ttdef"><b>Definition</b> types.h:52</div></div>
<div class="ttc" id="agroup__publictypes_html_gafb659914aac0129182d86f7d3414e85d"><div class="ttname"><a href="group__publictypes.html#gafb659914aac0129182d86f7d3414e85d">sir_options</a></div><div class="ttdeci">uint32_t sir_options</div><div class="ttdoc">sir_option bitmask type.</div><div class="ttdef"><b>Definition</b> types.h:96</div></div>
<div class="ttc" id="agroup__publictypes_html_structsir__errorinfo"><div class="ttname"><a href="group__publictypes.html#structsir__errorinfo">sir_errorinfo</a></div><div class="ttdoc">Information about an error that occurred.</div><div class="ttdef"><b>Definition</b> types.h:150</div></div>
<div class="ttc" id="agroup__publictypes_html_structsirinit"><div class="ttname"><a href="group__publictypes.html#structsirinit">sirinit</a></div><div class="ttdoc">libsir initialization and configuration data.</div><div class="ttdef"><b>Definition</b> types.h:244</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.7-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="sir_8h.html">sir.h</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
  </ul>
</div>
</body>
</html>
